Hash :
c46e6bac
Author :
Date :
2024-11-12T13:55:01
Make intermediate output symbol names consistent
Make intermediate output symbol names consistent across uses in
parameter names, struct names, variable names:
- built-in without quotes
- '' empty
- #satb ANGLE internal
- 'a' user-defined
Previously empty parameters would output the symbol id-generated
name ("sabb"), which was surprising when this is used only when
the symbol is in AngleInternal namespace, and not in Empty namespace.
Bug: angleproject:378584780
Change-Id: I87b13cf964a1ae3ee54b8f4ef7a00eddcd474760
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/6011018
Auto-Submit: Kimmo Kinnunen <kkinnunen@apple.com>
Commit-Queue: Geoff Lang <geofflang@chromium.org>
Reviewed-by: Geoff Lang <geofflang@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 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
//
// Copyright 2002 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.
//
#include "compiler/translator/SymbolTable.h"
#include "compiler/translator/tree_util/IntermTraverse.h"
namespace sh
{
namespace
{
void OutputFunction(TInfoSinkBase &out, const char *prefix, const TFunction *function)
{
out << prefix << ": " << static_cast<const TSymbol &>(*function);
}
void OutputVariable(TInfoSinkBase &out, const TVariable &variable)
{
out << static_cast<const TSymbol &>(variable) << " (" << variable.getType() << ")";
}
// Two purposes:
// 1. Show an example of how to iterate tree. Functions can also directly call traverse() on
// children themselves to have finer grained control over the process than shown here, though
// that's not recommended if it can be avoided.
// 2. Print out a text based description of the tree.
// The traverser subclass is used to carry along data from node to node in the traversal.
class TOutputTraverser : public TIntermTraverser
{
public:
TOutputTraverser(TInfoSinkBase &out)
: TIntermTraverser(true, false, false), mOut(out), mIndentDepth(0)
{}
protected:
void visitSymbol(TIntermSymbol *) override;
void visitConstantUnion(TIntermConstantUnion *) override;
bool visitSwizzle(Visit visit, TIntermSwizzle *node) override;
bool visitBinary(Visit visit, TIntermBinary *) override;
bool visitUnary(Visit visit, TIntermUnary *) override;
bool visitTernary(Visit visit, TIntermTernary *node) override;
bool visitIfElse(Visit visit, TIntermIfElse *node) override;
bool visitSwitch(Visit visit, TIntermSwitch *node) override;
bool visitCase(Visit visit, TIntermCase *node) override;
void visitFunctionPrototype(TIntermFunctionPrototype *node) override;
bool visitFunctionDefinition(Visit visit, TIntermFunctionDefinition *node) override;
bool visitAggregate(Visit visit, TIntermAggregate *) override;
bool visitBlock(Visit visit, TIntermBlock *) override;
bool visitGlobalQualifierDeclaration(Visit visit,
TIntermGlobalQualifierDeclaration *node) override;
bool visitDeclaration(Visit visit, TIntermDeclaration *node) override;
bool visitLoop(Visit visit, TIntermLoop *) override;
bool visitBranch(Visit visit, TIntermBranch *) override;
int getCurrentIndentDepth() const { return mIndentDepth + getCurrentTraversalDepth(); }
TInfoSinkBase &mOut;
int mIndentDepth;
};
//
// Helper functions for printing, not part of traversing.
//
void OutputTreeText(TInfoSinkBase &out, TIntermNode *node, const int depth)
{
int i;
out.location(node->getLine().first_file, node->getLine().first_line);
for (i = 0; i < depth; ++i)
out << " ";
}
//
// The rest of the file are the traversal functions. The last one
// is the one that starts the traversal.
//
// Return true from interior nodes to have the external traversal
// continue on to children. If you process children yourself,
// return false.
//
void TOutputTraverser::visitSymbol(TIntermSymbol *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
OutputVariable(mOut, node->variable());
mOut << "\n";
}
bool TOutputTraverser::visitSwizzle(Visit visit, TIntermSwizzle *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "vector swizzle (";
node->writeOffsetsAsXYZW(&mOut);
mOut << ")";
mOut << " (" << node->getType() << ")";
mOut << "\n";
return true;
}
bool TOutputTraverser::visitBinary(Visit visit, TIntermBinary *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
switch (node->getOp())
{
case EOpComma:
mOut << "comma";
break;
case EOpAssign:
mOut << "move second child to first child";
break;
case EOpInitialize:
mOut << "initialize first child with second child";
break;
case EOpAddAssign:
mOut << "add second child into first child";
break;
case EOpSubAssign:
mOut << "subtract second child into first child";
break;
case EOpMulAssign:
mOut << "multiply second child into first child";
break;
case EOpVectorTimesMatrixAssign:
mOut << "matrix mult second child into first child";
break;
case EOpVectorTimesScalarAssign:
mOut << "vector scale second child into first child";
break;
case EOpMatrixTimesScalarAssign:
mOut << "matrix scale second child into first child";
break;
case EOpMatrixTimesMatrixAssign:
mOut << "matrix mult second child into first child";
break;
case EOpDivAssign:
mOut << "divide second child into first child";
break;
case EOpIModAssign:
mOut << "modulo second child into first child";
break;
case EOpBitShiftLeftAssign:
mOut << "bit-wise shift first child left by second child";
break;
case EOpBitShiftRightAssign:
mOut << "bit-wise shift first child right by second child";
break;
case EOpBitwiseAndAssign:
mOut << "bit-wise and second child into first child";
break;
case EOpBitwiseXorAssign:
mOut << "bit-wise xor second child into first child";
break;
case EOpBitwiseOrAssign:
mOut << "bit-wise or second child into first child";
break;
case EOpIndexDirect:
mOut << "direct index";
break;
case EOpIndexIndirect:
mOut << "indirect index";
break;
case EOpIndexDirectStruct:
mOut << "direct index for structure";
break;
case EOpIndexDirectInterfaceBlock:
mOut << "direct index for interface block";
break;
case EOpAdd:
mOut << "add";
break;
case EOpSub:
mOut << "subtract";
break;
case EOpMul:
mOut << "component-wise multiply";
break;
case EOpDiv:
mOut << "divide";
break;
case EOpIMod:
mOut << "modulo";
break;
case EOpBitShiftLeft:
mOut << "bit-wise shift left";
break;
case EOpBitShiftRight:
mOut << "bit-wise shift right";
break;
case EOpBitwiseAnd:
mOut << "bit-wise and";
break;
case EOpBitwiseXor:
mOut << "bit-wise xor";
break;
case EOpBitwiseOr:
mOut << "bit-wise or";
break;
case EOpEqual:
mOut << "Compare Equal";
break;
case EOpNotEqual:
mOut << "Compare Not Equal";
break;
case EOpLessThan:
mOut << "Compare Less Than";
break;
case EOpGreaterThan:
mOut << "Compare Greater Than";
break;
case EOpLessThanEqual:
mOut << "Compare Less Than or Equal";
break;
case EOpGreaterThanEqual:
mOut << "Compare Greater Than or Equal";
break;
case EOpVectorTimesScalar:
mOut << "vector-scale";
break;
case EOpVectorTimesMatrix:
mOut << "vector-times-matrix";
break;
case EOpMatrixTimesVector:
mOut << "matrix-times-vector";
break;
case EOpMatrixTimesScalar:
mOut << "matrix-scale";
break;
case EOpMatrixTimesMatrix:
mOut << "matrix-multiply";
break;
case EOpLogicalOr:
mOut << "logical-or";
break;
case EOpLogicalXor:
mOut << "logical-xor";
break;
case EOpLogicalAnd:
mOut << "logical-and";
break;
default:
mOut << "<unknown op>";
}
mOut << " (" << node->getType() << ")";
mOut << "\n";
// Special handling for direct indexes. Because constant
// unions are not aware they are struct indexes, treat them
// here where we have that contextual knowledge.
if (node->getOp() == EOpIndexDirectStruct || node->getOp() == EOpIndexDirectInterfaceBlock)
{
node->getLeft()->traverse(this);
TIntermConstantUnion *intermConstantUnion = node->getRight()->getAsConstantUnion();
ASSERT(intermConstantUnion);
OutputTreeText(mOut, intermConstantUnion, getCurrentIndentDepth() + 1);
// The following code finds the field name from the constant union
const TConstantUnion *constantUnion = intermConstantUnion->getConstantValue();
const TStructure *structure = node->getLeft()->getType().getStruct();
const TInterfaceBlock *interfaceBlock = node->getLeft()->getType().getInterfaceBlock();
ASSERT(structure || interfaceBlock);
const TFieldList &fields = structure ? structure->fields() : interfaceBlock->fields();
const TField *field = fields[constantUnion->getIConst()];
mOut << constantUnion->getIConst() << " (field '" << field->name() << "')";
mOut << "\n";
return false;
}
return true;
}
bool TOutputTraverser::visitUnary(Visit visit, TIntermUnary *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
const TOperator op = node->getOp();
switch (op)
{
// Give verbose names for ops that have special syntax and some built-in functions that are
// easy to confuse with others, but mostly use GLSL names for functions.
case EOpNegative:
mOut << "Negate value";
break;
case EOpPositive:
mOut << "Positive sign";
break;
case EOpLogicalNot:
mOut << "negation";
break;
case EOpBitwiseNot:
mOut << "bit-wise not";
break;
case EOpPostIncrement:
mOut << "Post-Increment";
break;
case EOpPostDecrement:
mOut << "Post-Decrement";
break;
case EOpPreIncrement:
mOut << "Pre-Increment";
break;
case EOpPreDecrement:
mOut << "Pre-Decrement";
break;
case EOpArrayLength:
mOut << "Array length";
break;
case EOpNotComponentWise:
mOut << "component-wise not";
break;
default:
if (BuiltInGroup::IsBuiltIn(op))
{
OutputFunction(mOut, "Call a built-in function", node->getFunction());
}
else
{
mOut << GetOperatorString(node->getOp());
}
break;
}
mOut << " (" << node->getType() << ")";
mOut << "\n";
return true;
}
bool TOutputTraverser::visitFunctionDefinition(Visit visit, TIntermFunctionDefinition *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Function Definition:\n";
return true;
}
bool TOutputTraverser::visitGlobalQualifierDeclaration(Visit visit,
TIntermGlobalQualifierDeclaration *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
if (node->isPrecise())
{
mOut << "Precise Declaration:\n";
}
else
{
mOut << "Invariant Declaration:\n";
}
return true;
}
void TOutputTraverser::visitFunctionPrototype(TIntermFunctionPrototype *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
OutputFunction(mOut, "Function Prototype", node->getFunction());
mOut << " (" << node->getType() << ")";
mOut << "\n";
size_t paramCount = node->getFunction()->getParamCount();
for (size_t i = 0; i < paramCount; ++i)
{
const TVariable *param = node->getFunction()->getParam(i);
OutputTreeText(mOut, node, getCurrentIndentDepth() + 1);
mOut << "parameter: ";
OutputVariable(mOut, *param);
mOut << "\n";
}
}
bool TOutputTraverser::visitAggregate(Visit visit, TIntermAggregate *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
const TOperator op = node->getOp();
if (op == EOpNull)
{
mOut.prefix(SH_ERROR);
mOut << "node is still EOpNull!\n";
return true;
}
// Give verbose names for some built-in functions that are easy to confuse with others, but
// mostly use GLSL names for functions.
switch (op)
{
case EOpCallFunctionInAST:
OutputFunction(mOut, "Call a function", node->getFunction());
break;
case EOpCallInternalRawFunction:
OutputFunction(mOut, "Call an internal function with raw implementation",
node->getFunction());
break;
case EOpConstruct:
// The type of the constructor will be printed below.
mOut << "Construct";
break;
case EOpEqualComponentWise:
mOut << "component-wise equal";
break;
case EOpNotEqualComponentWise:
mOut << "component-wise not equal";
break;
case EOpLessThanComponentWise:
mOut << "component-wise less than";
break;
case EOpGreaterThanComponentWise:
mOut << "component-wise greater than";
break;
case EOpLessThanEqualComponentWise:
mOut << "component-wise less than or equal";
break;
case EOpGreaterThanEqualComponentWise:
mOut << "component-wise greater than or equal";
break;
case EOpDot:
mOut << "dot product";
break;
case EOpCross:
mOut << "cross product";
break;
case EOpMatrixCompMult:
mOut << "component-wise multiply";
break;
default:
if (BuiltInGroup::IsBuiltIn(op))
{
OutputFunction(mOut, "Call a built-in function", node->getFunction());
}
else
{
mOut << GetOperatorString(node->getOp());
}
break;
}
mOut << " (" << node->getType() << ")";
mOut << "\n";
return true;
}
bool TOutputTraverser::visitBlock(Visit visit, TIntermBlock *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Code block\n";
return true;
}
bool TOutputTraverser::visitDeclaration(Visit visit, TIntermDeclaration *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Declaration\n";
return true;
}
bool TOutputTraverser::visitTernary(Visit visit, TIntermTernary *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Ternary selection";
mOut << " (" << node->getType() << ")\n";
++mIndentDepth;
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Condition\n";
node->getCondition()->traverse(this);
OutputTreeText(mOut, node, getCurrentIndentDepth());
if (node->getTrueExpression())
{
mOut << "true case\n";
node->getTrueExpression()->traverse(this);
}
if (node->getFalseExpression())
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "false case\n";
node->getFalseExpression()->traverse(this);
}
--mIndentDepth;
return false;
}
bool TOutputTraverser::visitIfElse(Visit visit, TIntermIfElse *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "If test\n";
++mIndentDepth;
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Condition\n";
node->getCondition()->traverse(this);
OutputTreeText(mOut, node, getCurrentIndentDepth());
if (node->getTrueBlock())
{
mOut << "true case\n";
node->getTrueBlock()->traverse(this);
}
else
{
mOut << "true case is null\n";
}
if (node->getFalseBlock())
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "false case\n";
node->getFalseBlock()->traverse(this);
}
--mIndentDepth;
return false;
}
bool TOutputTraverser::visitSwitch(Visit visit, TIntermSwitch *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Switch\n";
return true;
}
bool TOutputTraverser::visitCase(Visit visit, TIntermCase *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
if (node->getCondition() == nullptr)
{
mOut << "Default\n";
}
else
{
mOut << "Case\n";
}
return true;
}
void TOutputTraverser::visitConstantUnion(TIntermConstantUnion *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Constant union" << " (" << node->getType() << ")" << "\n";
++mIndentDepth;
size_t size = node->getType().getObjectSize();
for (size_t i = 0; i < size; i++)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
switch (node->getConstantValue()[i].getType())
{
case EbtBool:
if (node->getConstantValue()[i].getBConst())
mOut << "true";
else
mOut << "false";
mOut << " (" << "const bool" << ")";
mOut << "\n";
break;
case EbtFloat:
mOut << node->getConstantValue()[i].getFConst();
mOut << " (const float)\n";
break;
case EbtInt:
mOut << node->getConstantValue()[i].getIConst();
mOut << " (const int)\n";
break;
case EbtUInt:
mOut << node->getConstantValue()[i].getUConst();
mOut << " (const uint)\n";
break;
case EbtYuvCscStandardEXT:
mOut << getYuvCscStandardEXTString(
node->getConstantValue()[i].getYuvCscStandardEXTConst());
mOut << " (const yuvCscStandardEXT)\n";
break;
default:
mOut.prefix(SH_ERROR);
mOut << "Unknown constant\n";
break;
}
}
--mIndentDepth;
}
bool TOutputTraverser::visitLoop(Visit visit, TIntermLoop *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Loop with condition ";
if (node->getType() == ELoopDoWhile)
mOut << "not ";
mOut << "tested first\n";
++mIndentDepth;
OutputTreeText(mOut, node, getCurrentIndentDepth());
if (node->getCondition())
{
mOut << "Loop Condition\n";
node->getCondition()->traverse(this);
}
else
{
mOut << "No loop condition\n";
}
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Loop Body\n";
node->getBody()->traverse(this);
if (node->getExpression())
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
mOut << "Loop Terminal Expression\n";
node->getExpression()->traverse(this);
}
--mIndentDepth;
return false;
}
bool TOutputTraverser::visitBranch(Visit visit, TIntermBranch *node)
{
OutputTreeText(mOut, node, getCurrentIndentDepth());
switch (node->getFlowOp())
{
case EOpKill:
mOut << "Branch: Kill";
break;
case EOpBreak:
mOut << "Branch: Break";
break;
case EOpContinue:
mOut << "Branch: Continue";
break;
case EOpReturn:
mOut << "Branch: Return";
break;
default:
mOut << "Branch: Unknown Branch";
break;
}
if (node->getExpression())
{
mOut << " with expression\n";
++mIndentDepth;
node->getExpression()->traverse(this);
--mIndentDepth;
}
else
{
mOut << "\n";
}
return false;
}
} // anonymous namespace
void OutputTree(TIntermNode *root, TInfoSinkBase &out)
{
TOutputTraverser it(out);
ASSERT(root);
root->traverse(&it);
}
} // namespace sh