Hash :
cc841237
Author :
Date :
2024-11-29T13:45:50
Accept framebuffer modifications while PLS is active The only way for a WebGL implementation to know if PLS is actually active is to call glGetIntegerv(PIXEL_LOCAL_STORAGE_ACTIVE_PLANES_ANGLE) (because glBeginPixelLocalStorageANGLE() can fail). So the original behavior of not allowing glBindFramebuffer() et. al. while PLS was active created a state scenario that was expensive for the browser to track. Instead, just allow glBindFramebuffer() et. al., and implicitly disable PLS if they are called while it's active. Bug: angleproject:40096838 Change-Id: Ibd303f9f9950fb5b7f1add2d41882e4379c51e62 Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/6060301 Reviewed-by: Kenneth Russell <kbr@chromium.org> Commit-Queue: Chris Dalton <chris@rive.app> Reviewed-by: Shahbaz Youssefi <syoussefi@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 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
//
// Copyright 2022 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.
//
// PixelLocalStorage.cpp: Defines the renderer-agnostic container classes
// gl::PixelLocalStorage and gl::PixelLocalStoragePlane for
// ANGLE_shader_pixel_local_storage.
#include "libANGLE/PixelLocalStorage.h"
#include <numeric>
#include "common/FixedVector.h"
#include "libANGLE/Context.h"
#include "libANGLE/Framebuffer.h"
#include "libANGLE/context_private_call_autogen.h"
#include "libANGLE/renderer/ContextImpl.h"
#include "libANGLE/renderer/TextureImpl.h"
namespace gl
{
// RAII utilities for working with GL state.
namespace
{
class ScopedBindTexture2D : angle::NonCopyable
{
public:
ScopedBindTexture2D(Context *context, TextureID texture)
: mContext(context),
mSavedTexBinding2D(
mContext->getState().getSamplerTextureId(mContext->getState().getActiveSampler(),
TextureType::_2D))
{
mContext->bindTexture(TextureType::_2D, texture);
}
~ScopedBindTexture2D() { mContext->bindTexture(TextureType::_2D, mSavedTexBinding2D); }
private:
Context *const mContext;
TextureID mSavedTexBinding2D;
};
class ScopedRestoreDrawFramebuffer : angle::NonCopyable
{
public:
ScopedRestoreDrawFramebuffer(Context *context)
: mContext(context), mSavedFramebuffer(mContext->getState().getDrawFramebuffer())
{
ASSERT(mSavedFramebuffer);
}
~ScopedRestoreDrawFramebuffer() { mContext->bindDrawFramebuffer(mSavedFramebuffer->id()); }
private:
Context *const mContext;
Framebuffer *const mSavedFramebuffer;
};
class ScopedDisableScissor : angle::NonCopyable
{
public:
ScopedDisableScissor(Context *context)
: mContext(context), mScissorTestEnabled(mContext->getState().isScissorTestEnabled())
{
if (mScissorTestEnabled)
{
ContextPrivateDisable(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), GL_SCISSOR_TEST);
}
}
~ScopedDisableScissor()
{
if (mScissorTestEnabled)
{
ContextPrivateEnable(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), GL_SCISSOR_TEST);
}
}
private:
Context *const mContext;
const GLint mScissorTestEnabled;
};
class ScopedEnableColorMask : angle::NonCopyable
{
public:
ScopedEnableColorMask(Context *context, int numDrawBuffers)
: mContext(context), mNumDrawBuffers(numDrawBuffers)
{
const State &state = mContext->getState();
if (!mContext->getExtensions().drawBuffersIndexedAny())
{
std::array<bool, 4> &mask = mSavedColorMasks[0];
state.getBlendStateExt().getColorMaskIndexed(0, &mask[0], &mask[1], &mask[2], &mask[3]);
ContextPrivateColorMask(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), GL_TRUE, GL_TRUE,
GL_TRUE, GL_TRUE);
}
else
{
for (int i = 0; i < mNumDrawBuffers; ++i)
{
std::array<bool, 4> &mask = mSavedColorMasks[i];
state.getBlendStateExt().getColorMaskIndexed(i, &mask[0], &mask[1], &mask[2],
&mask[3]);
ContextPrivateColorMaski(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), i, GL_TRUE,
GL_TRUE, GL_TRUE, GL_TRUE);
}
}
}
~ScopedEnableColorMask()
{
if (!mContext->getExtensions().drawBuffersIndexedAny())
{
const std::array<bool, 4> &mask = mSavedColorMasks[0];
ContextPrivateColorMask(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), mask[0], mask[1],
mask[2], mask[3]);
}
else
{
for (int i = 0; i < mNumDrawBuffers; ++i)
{
const std::array<bool, 4> &mask = mSavedColorMasks[i];
ContextPrivateColorMaski(mContext->getMutablePrivateState(),
mContext->getMutablePrivateStateCache(), i, mask[0],
mask[1], mask[2], mask[3]);
}
}
}
private:
Context *const mContext;
const int mNumDrawBuffers;
DrawBuffersArray<std::array<bool, 4>> mSavedColorMasks;
};
} // namespace
PixelLocalStoragePlane::PixelLocalStoragePlane() : mTextureObserver(this, 0) {}
PixelLocalStoragePlane::~PixelLocalStoragePlane()
{
// Call deinitialize or onContextObjectsLost first!
// (PixelLocalStorage::deleteContextObjects calls deinitialize.)
ASSERT(isDeinitialized());
// We can always expect to receive angle::SubjectMessage::TextureIDDeleted, even if our texture
// isn't deleted until context teardown. For this reason, we don't need to hold a ref on the
// underlying texture that is the subject of mTextureObserver.
ASSERT(mTextureObserver.getSubject() == nullptr);
}
void PixelLocalStoragePlane::onContextObjectsLost()
{
// We normally call deleteTexture on the memoryless plane texture ID, since we own it, but in
// this case we can let it go.
mTextureID = TextureID();
deinitialize(nullptr);
}
void PixelLocalStoragePlane::deinitialize(Context *context)
{
if (mMemoryless && mTextureID.value != 0)
{
ASSERT(context);
context->deleteTexture(mTextureID); // Will deinitialize the texture via observers.
}
else
{
mInternalformat = GL_NONE;
mMemoryless = false;
mTextureID = TextureID();
mTextureObserver.reset();
}
ASSERT(isDeinitialized());
}
void PixelLocalStoragePlane::setMemoryless(Context *context, GLenum internalformat)
{
deinitialize(context);
mInternalformat = internalformat;
mMemoryless = true;
// The backing texture will get allocated lazily, once we know what dimensions it should be.
ASSERT(mTextureID.value == 0);
mTextureImageIndex = ImageIndex::MakeFromType(TextureType::_2D, 0, 0);
}
void PixelLocalStoragePlane::setTextureBacked(Context *context, Texture *tex, int level, int layer)
{
deinitialize(context);
ASSERT(tex->getImmutableFormat());
mInternalformat = tex->getState().getBaseLevelDesc().format.info->internalFormat;
mMemoryless = false;
mTextureID = tex->id();
mTextureObserver.bind(tex);
mTextureImageIndex = ImageIndex::MakeFromType(tex->getType(), level, layer);
}
void PixelLocalStoragePlane::onSubjectStateChange(angle::SubjectIndex index,
angle::SubjectMessage message)
{
ASSERT(index == 0);
switch (message)
{
case angle::SubjectMessage::TextureIDDeleted:
// When a texture object is deleted, any pixel local storage plane to which it is bound
// is automatically deinitialized.
ASSERT(mTextureID.value != 0);
mTextureID = TextureID();
deinitialize(nullptr);
break;
default:
break;
}
}
bool PixelLocalStoragePlane::isDeinitialized() const
{
if (mInternalformat == GL_NONE)
{
ASSERT(!isMemoryless());
ASSERT(mTextureID.value == 0);
ASSERT(mTextureObserver.getSubject() == nullptr);
return true;
}
return false;
}
GLint PixelLocalStoragePlane::getIntegeri(GLenum target) const
{
if (!isDeinitialized())
{
switch (target)
{
case GL_PIXEL_LOCAL_FORMAT_ANGLE:
return mInternalformat;
case GL_PIXEL_LOCAL_TEXTURE_NAME_ANGLE:
return isMemoryless() ? 0 : mTextureID.value;
case GL_PIXEL_LOCAL_TEXTURE_LEVEL_ANGLE:
return isMemoryless() ? 0 : mTextureImageIndex.getLevelIndex();
case GL_PIXEL_LOCAL_TEXTURE_LAYER_ANGLE:
return isMemoryless() ? 0 : mTextureImageIndex.getLayerIndex();
}
}
// Since GL_NONE == 0, PLS queries all return 0 when the plane is deinitialized.
static_assert(GL_NONE == 0, "Expecting GL_NONE to be zero.");
return 0;
}
bool PixelLocalStoragePlane::getTextureImageExtents(const Context *context, Extents *extents) const
{
ASSERT(!isDeinitialized());
if (isMemoryless())
{
return false;
}
Texture *tex = context->getTexture(mTextureID);
ASSERT(tex != nullptr);
*extents = tex->getExtents(mTextureImageIndex.getTarget(), mTextureImageIndex.getLevelIndex());
extents->depth = 0;
return true;
}
void PixelLocalStoragePlane::ensureBackingTextureIfMemoryless(Context *context, Extents plsExtents)
{
ASSERT(!isDeinitialized());
if (!isMemoryless())
{
ASSERT(mTextureID.value != 0);
return;
}
// Internal textures backing memoryless planes are always 2D and not mipmapped.
ASSERT(mTextureImageIndex.getType() == TextureType::_2D);
ASSERT(mTextureImageIndex.getLevelIndex() == 0);
ASSERT(mTextureImageIndex.getLayerIndex() == 0);
Texture *tex = nullptr;
if (mTextureID.value != 0)
{
tex = context->getTexture(mTextureID);
ASSERT(tex != nullptr);
}
// Do we need to allocate a new backing texture?
if (tex == nullptr ||
static_cast<GLsizei>(tex->getWidth(TextureTarget::_2D, 0)) != plsExtents.width ||
static_cast<GLsizei>(tex->getHeight(TextureTarget::_2D, 0)) != plsExtents.height)
{
// Call setMemoryless() to release our current data, if any.
setMemoryless(context, mInternalformat);
ASSERT(mTextureID.value == 0);
// Create a new texture that backs the memoryless plane.
mTextureID = context->createTexture();
{
ScopedBindTexture2D scopedBindTexture2D(context, mTextureID);
context->bindTexture(TextureType::_2D, mTextureID);
context->texStorage2D(TextureType::_2D, 1, mInternalformat, plsExtents.width,
plsExtents.height);
}
tex = context->getTexture(mTextureID);
ASSERT(tex != nullptr);
ASSERT(tex->id() == mTextureID);
mTextureObserver.bind(tex);
}
}
void PixelLocalStoragePlane::attachToDrawFramebuffer(Context *context, GLenum colorAttachment) const
{
ASSERT(!isDeinitialized());
// Call ensureBackingTextureIfMemoryless() first!
ASSERT(mTextureID.value != 0 && context->getTexture(mTextureID) != nullptr);
if (mTextureImageIndex.usesTex3D()) // GL_TEXTURE_3D or GL_TEXTURE_2D_ARRAY.
{
context->framebufferTextureLayer(GL_DRAW_FRAMEBUFFER, colorAttachment, mTextureID,
mTextureImageIndex.getLevelIndex(),
mTextureImageIndex.getLayerIndex());
}
else
{
context->framebufferTexture2D(GL_DRAW_FRAMEBUFFER, colorAttachment,
mTextureImageIndex.getTarget(), mTextureID,
mTextureImageIndex.getLevelIndex());
}
}
// Clears the draw buffer at 0-based index 'drawBufferIdx' on the current framebuffer.
class ClearBufferCommands : public PixelLocalStoragePlane::ClearCommands
{
public:
ClearBufferCommands(Context *context) : mContext(context) {}
void clearfv(int drawBufferIdx, const GLfloat value[]) const override
{
mContext->clearBufferfv(GL_COLOR, drawBufferIdx, value);
}
void cleariv(int drawBufferIdx, const GLint value[]) const override
{
mContext->clearBufferiv(GL_COLOR, drawBufferIdx, value);
}
void clearuiv(int drawBufferIdx, const GLuint value[]) const override
{
mContext->clearBufferuiv(GL_COLOR, drawBufferIdx, value);
}
private:
Context *const mContext;
};
template <typename T, size_t N>
void ClampArray(std::array<T, N> &arr, T lo, T hi)
{
for (T &x : arr)
{
x = std::clamp(x, lo, hi);
}
}
void PixelLocalStoragePlane::issueClearCommand(ClearCommands *clearCommands,
int target,
GLenum loadop) const
{
switch (mInternalformat)
{
case GL_RGBA8:
case GL_R32F:
{
std::array<GLfloat, 4> clearValue = {0, 0, 0, 0};
if (loadop == GL_LOAD_OP_CLEAR_ANGLE)
{
clearValue = mClearValuef;
if (mInternalformat == GL_RGBA8)
{
ClampArray(clearValue, 0.f, 1.f);
}
}
clearCommands->clearfv(target, clearValue.data());
break;
}
case GL_RGBA8I:
{
std::array<GLint, 4> clearValue = {0, 0, 0, 0};
if (loadop == GL_LOAD_OP_CLEAR_ANGLE)
{
clearValue = mClearValuei;
ClampArray(clearValue, -128, 127);
}
clearCommands->cleariv(target, clearValue.data());
break;
}
case GL_RGBA8UI:
case GL_R32UI:
{
std::array<GLuint, 4> clearValue = {0, 0, 0, 0};
if (loadop == GL_LOAD_OP_CLEAR_ANGLE)
{
clearValue = mClearValueui;
if (mInternalformat == GL_RGBA8UI)
{
ClampArray(clearValue, 0u, 255u);
}
}
clearCommands->clearuiv(target, clearValue.data());
break;
}
default:
// Invalid PLS internalformats should not have made it this far.
UNREACHABLE();
}
}
void PixelLocalStoragePlane::bindToImage(Context *context, GLuint unit, bool needsR32Packing) const
{
ASSERT(!isDeinitialized());
// Call ensureBackingTextureIfMemoryless() first!
ASSERT(mTextureID.value != 0 && context->getTexture(mTextureID) != nullptr);
GLenum imageBindingFormat = mInternalformat;
if (needsR32Packing)
{
// D3D and ES require us to pack all PLS formats into r32f, r32i, or r32ui images.
switch (imageBindingFormat)
{
case GL_RGBA8:
case GL_RGBA8UI:
imageBindingFormat = GL_R32UI;
break;
case GL_RGBA8I:
imageBindingFormat = GL_R32I;
break;
}
}
context->bindImageTexture(unit, mTextureID, mTextureImageIndex.getLevelIndex(), GL_FALSE,
mTextureImageIndex.getLayerIndex(), GL_READ_WRITE,
imageBindingFormat);
}
const Texture *PixelLocalStoragePlane::getBackingTexture(const Context *context) const
{
ASSERT(!isDeinitialized());
ASSERT(!isMemoryless());
const Texture *tex = context->getTexture(mTextureID);
ASSERT(tex != nullptr);
return tex;
}
PixelLocalStorage::PixelLocalStorage(const ShPixelLocalStorageOptions &plsOptions, const Caps &caps)
: mPLSOptions(plsOptions), mPlanes(caps.maxPixelLocalStoragePlanes)
{}
PixelLocalStorage::~PixelLocalStorage() {}
namespace
{
bool AllPlanesDeinitialized(
const angle::FixedVector<PixelLocalStoragePlane, IMPLEMENTATION_MAX_PIXEL_LOCAL_STORAGE_PLANES>
&planes,
const Context *context)
{
for (const PixelLocalStoragePlane &plane : planes)
{
if (!plane.isDeinitialized())
{
return false;
}
}
return true;
}
} // namespace
void PixelLocalStorage::onFramebufferDestroyed(const Context *context)
{
if (!context->isReferenced())
{
// If the Context's refcount is zero, we know it's in a teardown state and we can just let
// go of our GL objects -- they get cleaned up as part of context teardown. Otherwise, the
// Context should have called deleteContextObjects before reaching this point.
onContextObjectsLost();
for (PixelLocalStoragePlane &plane : mPlanes)
{
plane.onContextObjectsLost();
}
}
// Call deleteContextObjects() when a Framebuffer is destroyed outside of context teardown!
ASSERT(AllPlanesDeinitialized(mPlanes, context));
}
void PixelLocalStorage::deleteContextObjects(Context *context)
{
onDeleteContextObjects(context);
for (PixelLocalStoragePlane &plane : mPlanes)
{
plane.deinitialize(context);
}
}
void PixelLocalStorage::begin(Context *context, GLsizei n, const GLenum loadops[])
{
// Find the pixel local storage rendering dimensions.
Extents plsExtents;
bool hasPLSExtents = false;
for (GLsizei i = 0; i < n; ++i)
{
PixelLocalStoragePlane &plane = mPlanes[i];
if (plane.getTextureImageExtents(context, &plsExtents))
{
hasPLSExtents = true;
break;
}
}
if (!hasPLSExtents)
{
// All PLS planes are memoryless. Use the rendering area of the framebuffer instead.
plsExtents =
context->getState().getDrawFramebuffer()->getState().getAttachmentExtentsIntersection();
ASSERT(plsExtents.depth == 0);
}
for (GLsizei i = 0; i < n; ++i)
{
PixelLocalStoragePlane &plane = mPlanes[i];
if (mPLSOptions.type == ShPixelLocalStorageType::ImageLoadStore ||
mPLSOptions.type == ShPixelLocalStorageType::FramebufferFetch)
{
plane.ensureBackingTextureIfMemoryless(context, plsExtents);
}
plane.markActive(true);
}
// Disable blend and enable the full color mask on the draw buffers reserved for PLS.
const Caps &caps = context->getCaps();
GLint firstPLSDrawBuffer = FirstOverriddenDrawBuffer(caps, n);
PrivateState *privateState = context->getMutablePrivateState();
if (firstPLSDrawBuffer == 0)
{
privateState->setBlend(false);
privateState->setColorMask(true, true, true, true);
}
else
{
ASSERT(context->getExtensions().drawBuffersIndexedAny());
for (GLint i = firstPLSDrawBuffer; i < caps.maxDrawBuffers; ++i)
{
privateState->setBlendIndexed(false, i);
privateState->setColorMaskIndexed(true, true, true, true, i);
}
}
onBegin(context, n, loadops, plsExtents);
}
void PixelLocalStorage::end(Context *context, GLsizei n, const GLenum storeops[])
{
onEnd(context, n, storeops);
for (GLsizei i = 0; i < n; ++i)
{
mPlanes[i].markActive(false);
}
}
void PixelLocalStorage::barrier(Context *context)
{
ASSERT(!context->getExtensions().shaderPixelLocalStorageCoherentANGLE);
onBarrier(context);
}
void PixelLocalStorage::interrupt(Context *context)
{
if (mInterruptCount == 0)
{
mActivePlanesAtInterrupt = context->getState().getPixelLocalStorageActivePlanes();
ASSERT(0 <= mActivePlanesAtInterrupt &&
mActivePlanesAtInterrupt <= IMPLEMENTATION_MAX_PIXEL_LOCAL_STORAGE_PLANES);
if (mActivePlanesAtInterrupt != 0)
{
context->endPixelLocalStorageImplicit();
}
}
++mInterruptCount;
ASSERT(mInterruptCount > 0);
}
void PixelLocalStorage::restore(Context *context)
{
ASSERT(mInterruptCount > 0);
--mInterruptCount;
ASSERT(0 <= mActivePlanesAtInterrupt &&
mActivePlanesAtInterrupt <= IMPLEMENTATION_MAX_PIXEL_LOCAL_STORAGE_PLANES);
if (mInterruptCount == 0 && mActivePlanesAtInterrupt >= 1)
{
angle::FixedVector<GLenum, IMPLEMENTATION_MAX_PIXEL_LOCAL_STORAGE_PLANES> loadops(
mActivePlanesAtInterrupt);
for (GLsizei i = 0; i < mActivePlanesAtInterrupt; ++i)
{
loadops[i] = mPlanes[i].isMemoryless() ? GL_DONT_CARE : GL_LOAD_OP_LOAD_ANGLE;
}
context->beginPixelLocalStorage(mActivePlanesAtInterrupt, loadops.data());
}
}
namespace
{
// Implements pixel local storage with image load/store shader operations.
class PixelLocalStorageImageLoadStore : public PixelLocalStorage
{
public:
PixelLocalStorageImageLoadStore(const ShPixelLocalStorageOptions &plsOptions, const Caps &caps)
: PixelLocalStorage(plsOptions, caps)
{
ASSERT(mPLSOptions.type == ShPixelLocalStorageType::ImageLoadStore);
}
// Call deleteContextObjects or onContextObjectsLost first!
~PixelLocalStorageImageLoadStore() override
{
ASSERT(mScratchFramebufferForClearing.value == 0);
}
void onContextObjectsLost() override
{
mScratchFramebufferForClearing = FramebufferID(); // Let go of GL objects.
}
void onDeleteContextObjects(Context *context) override
{
if (mScratchFramebufferForClearing.value != 0)
{
context->deleteFramebuffer(mScratchFramebufferForClearing);
mScratchFramebufferForClearing = FramebufferID();
}
}
void onBegin(Context *context, GLsizei n, const GLenum loadops[], Extents plsExtents) override
{
// Save the image bindings so we can restore them during onEnd().
const State &state = context->getState();
ASSERT(static_cast<size_t>(n) <= state.getImageUnits().size());
mSavedImageBindings.clear();
mSavedImageBindings.reserve(n);
for (GLsizei i = 0; i < n; ++i)
{
mSavedImageBindings.emplace_back(state.getImageUnit(i));
}
Framebuffer *framebuffer = state.getDrawFramebuffer();
if (mPLSOptions.renderPassNeedsAMDRasterOrderGroupsWorkaround)
{
// anglebug.com/42266263 -- Metal [[raster_order_group()]] does not work for read_write
// textures on AMD when the render pass doesn't have a color attachment on slot 0. To
// work around this we attach one of the PLS textures to GL_COLOR_ATTACHMENT0, if there
// isn't one already.
// It's important to keep the attachment enabled so that it's set in the corresponding
// MTLRenderPassAttachmentDescriptor. As the fragment shader does not have any output
// bound to this attachment, set the color write mask to all-disabled.
// Note that the PLS extension disallows simultaneously binding a single texture image
// to a PLS plane and attaching it to the draw framebuffer. Enabling this workaround on
// any other platform would yield incorrect results.
// This flag is set to true iff the framebuffer has an attachment 0 and it is enabled.
mHadColorAttachment0 = framebuffer->getDrawBufferMask().test(0);
if (!mHadColorAttachment0)
{
// Indexed color masks are always available on Metal.
ASSERT(context->getExtensions().drawBuffersIndexedAny());
// Remember the current draw buffer 0 color mask and set it to all-disabled.
state.getBlendStateExt().getColorMaskIndexed(
0, &mSavedColorMask[0], &mSavedColorMask[1], &mSavedColorMask[2],
&mSavedColorMask[3]);
ContextPrivateColorMaski(context->getMutablePrivateState(),
context->getMutablePrivateStateCache(), 0, false, false,
false, false);
// Remember the current draw buffer state so we can restore it during onEnd().
const DrawBuffersVector<GLenum> &appDrawBuffers =
framebuffer->getDrawBufferStates();
mSavedDrawBuffers.resize(appDrawBuffers.size());
std::copy(appDrawBuffers.begin(), appDrawBuffers.end(), mSavedDrawBuffers.begin());
// Turn on draw buffer 0.
if (mSavedDrawBuffers[0] != GL_COLOR_ATTACHMENT0)
{
GLenum drawBuffer0 = mSavedDrawBuffers[0];
mSavedDrawBuffers[0] = GL_COLOR_ATTACHMENT0;
context->drawBuffers(static_cast<GLsizei>(mSavedDrawBuffers.size()),
mSavedDrawBuffers.data());
mSavedDrawBuffers[0] = drawBuffer0;
}
// Attach one of the PLS textures to GL_COLOR_ATTACHMENT0.
getPlane(0).attachToDrawFramebuffer(context, GL_COLOR_ATTACHMENT0);
}
}
else
{
// Save the default framebuffer width/height so we can restore it during onEnd().
mSavedFramebufferDefaultWidth = framebuffer->getDefaultWidth();
mSavedFramebufferDefaultHeight = framebuffer->getDefaultHeight();
// Specify the framebuffer width/height explicitly in case we end up rendering
// exclusively to shader images.
context->framebufferParameteri(GL_DRAW_FRAMEBUFFER, GL_FRAMEBUFFER_DEFAULT_WIDTH,
plsExtents.width);
context->framebufferParameteri(GL_DRAW_FRAMEBUFFER, GL_FRAMEBUFFER_DEFAULT_HEIGHT,
plsExtents.height);
}
// Guard GL state and bind a scratch framebuffer in case we need to reallocate or clear any
// PLS planes.
const size_t maxDrawBuffers = context->getCaps().maxDrawBuffers;
ScopedRestoreDrawFramebuffer ScopedRestoreDrawFramebuffer(context);
if (mScratchFramebufferForClearing.value == 0)
{
context->genFramebuffers(1, &mScratchFramebufferForClearing);
context->bindFramebuffer(GL_DRAW_FRAMEBUFFER, mScratchFramebufferForClearing);
// Turn on all draw buffers on the scratch framebuffer for clearing.
DrawBuffersVector<GLenum> drawBuffers(maxDrawBuffers);
std::iota(drawBuffers.begin(), drawBuffers.end(), GL_COLOR_ATTACHMENT0);
context->drawBuffers(static_cast<int>(drawBuffers.size()), drawBuffers.data());
}
else
{
context->bindFramebuffer(GL_DRAW_FRAMEBUFFER, mScratchFramebufferForClearing);
}
ScopedDisableScissor scopedDisableScissor(context);
// Bind and clear the PLS planes.
size_t maxClearedAttachments = 0;
for (GLsizei i = 0; i < n;)
{
DrawBuffersVector<int> pendingClears;
for (; pendingClears.size() < maxDrawBuffers && i < n; ++i)
{
GLenum loadop = loadops[i];
const PixelLocalStoragePlane &plane = getPlane(i);
plane.bindToImage(context, i, !mPLSOptions.supportsNativeRGBA8ImageFormats);
if (loadop == GL_LOAD_OP_ZERO_ANGLE || loadop == GL_LOAD_OP_CLEAR_ANGLE)
{
plane.attachToDrawFramebuffer(
context, GL_COLOR_ATTACHMENT0 + static_cast<GLenum>(pendingClears.size()));
pendingClears.push_back(i); // Defer the clear for later.
}
}
// Clear in batches in order to be more efficient with GL state.
ScopedEnableColorMask scopedEnableColorMask(context,
static_cast<int>(pendingClears.size()));
ClearBufferCommands clearBufferCommands(context);
for (size_t drawBufferIdx = 0; drawBufferIdx < pendingClears.size(); ++drawBufferIdx)
{
int plsIdx = pendingClears[drawBufferIdx];
getPlane(plsIdx).issueClearCommand(
&clearBufferCommands, static_cast<int>(drawBufferIdx), loadops[plsIdx]);
}
maxClearedAttachments = std::max(maxClearedAttachments, pendingClears.size());
}
// Detach the cleared PLS textures from the scratch framebuffer.
for (size_t i = 0; i < maxClearedAttachments; ++i)
{
context->framebufferTexture2D(GL_DRAW_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0 + static_cast<GLenum>(i),
TextureTarget::_2D, TextureID(), 0);
}
// Unlike other barriers, GL_SHADER_IMAGE_ACCESS_BARRIER_BIT also synchronizes all types of
// memory accesses that happened before the barrier:
//
// SHADER_IMAGE_ACCESS_BARRIER_BIT: Memory accesses using shader built-in image load and
// store functions issued after the barrier will reflect data written by shaders prior to
// the barrier. Additionally, image stores issued after the barrier will not execute until
// all memory accesses (e.g., loads, stores, texture fetches, vertex fetches) initiated
// prior to the barrier complete.
//
// So we don't any barriers other than GL_SHADER_IMAGE_ACCESS_BARRIER_BIT during begin().
context->memoryBarrier(GL_SHADER_IMAGE_ACCESS_BARRIER_BIT);
}
void onEnd(Context *context, GLsizei n, const GLenum storeops[]) override
{
// Restore the image bindings. Since glBindImageTexture and any commands that modify
// textures are banned while PLS is active, these will all still be alive and valid.
ASSERT(mSavedImageBindings.size() == static_cast<size_t>(n));
for (GLuint unit = 0; unit < mSavedImageBindings.size(); ++unit)
{
ImageUnit &binding = mSavedImageBindings[unit];
context->bindImageTexture(unit, binding.texture.id(), binding.level, binding.layered,
binding.layer, binding.access, binding.format);
// BindingPointers have to be explicitly cleaned up.
binding.texture.set(context, nullptr);
}
mSavedImageBindings.clear();
if (mPLSOptions.renderPassNeedsAMDRasterOrderGroupsWorkaround)
{
if (!mHadColorAttachment0)
{
// Detach the PLS texture we attached to GL_COLOR_ATTACHMENT0.
context->framebufferTexture2D(GL_DRAW_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
TextureTarget::_2D, TextureID(), 0);
// Restore the draw buffer state from before PLS was enabled.
if (mSavedDrawBuffers[0] != GL_COLOR_ATTACHMENT0)
{
context->drawBuffers(static_cast<GLsizei>(mSavedDrawBuffers.size()),
mSavedDrawBuffers.data());
}
mSavedDrawBuffers.clear();
// Restore the draw buffer 0 color mask.
ContextPrivateColorMaski(
context->getMutablePrivateState(), context->getMutablePrivateStateCache(), 0,
mSavedColorMask[0], mSavedColorMask[1], mSavedColorMask[2], mSavedColorMask[3]);
}
}
else
{
// Restore the default framebuffer width/height.
context->framebufferParameteri(GL_DRAW_FRAMEBUFFER, GL_FRAMEBUFFER_DEFAULT_WIDTH,
mSavedFramebufferDefaultWidth);
context->framebufferParameteri(GL_DRAW_FRAMEBUFFER, GL_FRAMEBUFFER_DEFAULT_HEIGHT,
mSavedFramebufferDefaultHeight);
}
// We need ALL_BARRIER_BITS during end() because GL_SHADER_IMAGE_ACCESS_BARRIER_BIT doesn't
// synchronize all types of memory accesses that can happen after the barrier.
context->memoryBarrier(GL_ALL_BARRIER_BITS);
}
void onBarrier(Context *context) override
{
context->memoryBarrier(GL_SHADER_IMAGE_ACCESS_BARRIER_BIT);
}
private:
// D3D and ES require us to pack all PLS formats into r32f, r32i, or r32ui images.
FramebufferID mScratchFramebufferForClearing{};
// Saved values to restore during onEnd().
std::vector<ImageUnit> mSavedImageBindings;
// If mPLSOptions.plsRenderPassNeedsColorAttachmentWorkaround.
bool mHadColorAttachment0;
std::array<bool, 4> mSavedColorMask;
DrawBuffersVector<GLenum> mSavedDrawBuffers;
// If !mPLSOptions.plsRenderPassNeedsColorAttachmentWorkaround.
GLint mSavedFramebufferDefaultWidth;
GLint mSavedFramebufferDefaultHeight;
};
// Implements pixel local storage via framebuffer fetch.
class PixelLocalStorageFramebufferFetch : public PixelLocalStorage
{
public:
PixelLocalStorageFramebufferFetch(const ShPixelLocalStorageOptions &plsOptions,
const Caps &caps)
: PixelLocalStorage(plsOptions, caps)
{
ASSERT(mPLSOptions.type == ShPixelLocalStorageType::FramebufferFetch);
}
void onContextObjectsLost() override {}
void onDeleteContextObjects(Context *) override {}
void onBegin(Context *context, GLsizei n, const GLenum loadops[], Extents plsExtents) override
{
const Caps &caps = context->getCaps();
Framebuffer *framebuffer = context->getState().getDrawFramebuffer();
const DrawBuffersVector<GLenum> &appDrawBuffers = framebuffer->getDrawBufferStates();
// Remember the current draw buffer state so we can restore it during onEnd().
mSavedDrawBuffers.resize(appDrawBuffers.size());
std::copy(appDrawBuffers.begin(), appDrawBuffers.end(), mSavedDrawBuffers.begin());
// Set up new draw buffers for PLS.
int firstPLSDrawBuffer = caps.maxCombinedDrawBuffersAndPixelLocalStoragePlanes - n;
int numAppDrawBuffers =
std::min(static_cast<int>(appDrawBuffers.size()), firstPLSDrawBuffer);
DrawBuffersArray<GLenum> plsDrawBuffers;
std::copy(appDrawBuffers.begin(), appDrawBuffers.begin() + numAppDrawBuffers,
plsDrawBuffers.begin());
std::fill(plsDrawBuffers.begin() + numAppDrawBuffers,
plsDrawBuffers.begin() + firstPLSDrawBuffer, GL_NONE);
bool needsClear = false;
for (GLsizei i = 0; i < n; ++i)
{
GLuint drawBufferIdx = GetDrawBufferIdx(caps, i);
GLenum loadop = loadops[i];
const PixelLocalStoragePlane &plane = getPlane(i);
ASSERT(!plane.isDeinitialized());
// Attach our PLS texture to the framebuffer. Validation should have already ensured
// nothing else was attached at this point.
GLenum colorAttachment = GL_COLOR_ATTACHMENT0 + drawBufferIdx;
ASSERT(!framebuffer->getAttachment(context, colorAttachment));
plane.attachToDrawFramebuffer(context, colorAttachment);
plsDrawBuffers[drawBufferIdx] = colorAttachment;
needsClear = needsClear || (loadop != GL_LOAD_OP_LOAD_ANGLE);
}
// Turn on the PLS draw buffers.
context->drawBuffers(caps.maxCombinedDrawBuffersAndPixelLocalStoragePlanes,
plsDrawBuffers.data());
// Clear the non-LOAD_OP_LOAD PLS planes now that their draw buffers are turned on.
if (needsClear)
{
ScopedDisableScissor scopedDisableScissor(context);
ClearBufferCommands clearBufferCommands(context);
for (GLsizei i = 0; i < n; ++i)
{
GLenum loadop = loadops[i];
if (loadop != GL_LOAD_OP_LOAD_ANGLE)
{
GLuint drawBufferIdx = GetDrawBufferIdx(caps, i);
getPlane(i).issueClearCommand(&clearBufferCommands, drawBufferIdx, loadop);
}
}
}
if (!context->getExtensions().shaderPixelLocalStorageCoherentANGLE)
{
// Insert a barrier if we aren't coherent, since the textures may have been rendered to
// previously.
barrier(context);
}
}
void onEnd(Context *context, GLsizei n, const GLenum storeops[]) override
{
const Caps &caps = context->getCaps();
// Invalidate the non-preserved PLS attachments.
DrawBuffersVector<GLenum> invalidateList;
for (GLsizei i = n - 1; i >= 0; --i)
{
if (!getPlane(i).isActive())
{
continue;
}
if (storeops[i] != GL_STORE_OP_STORE_ANGLE || getPlane(i).isMemoryless())
{
int drawBufferIdx = GetDrawBufferIdx(caps, i);
invalidateList.push_back(GL_COLOR_ATTACHMENT0 + drawBufferIdx);
}
}
if (!invalidateList.empty())
{
context->invalidateFramebuffer(GL_DRAW_FRAMEBUFFER,
static_cast<GLsizei>(invalidateList.size()),
invalidateList.data());
}
for (GLsizei i = 0; i < n; ++i)
{
// Reset color attachments where PLS was attached. Validation should have already
// ensured nothing was attached at these points when we activated pixel local storage,
// and that nothing got attached during.
GLuint drawBufferIdx = GetDrawBufferIdx(caps, i);
GLenum colorAttachment = GL_COLOR_ATTACHMENT0 + drawBufferIdx;
context->framebufferTexture2D(GL_DRAW_FRAMEBUFFER, colorAttachment, TextureTarget::_2D,
TextureID(), 0);
}
// Restore the draw buffer state from before PLS was enabled.
context->drawBuffers(static_cast<GLsizei>(mSavedDrawBuffers.size()),
mSavedDrawBuffers.data());
mSavedDrawBuffers.clear();
}
void onBarrier(Context *context) override { context->framebufferFetchBarrier(); }
private:
static GLuint GetDrawBufferIdx(const Caps &caps, GLuint plsPlaneIdx)
{
// Bind the PLS attachments in reverse order from the rear. This way, the shader translator
// doesn't need to know how many planes are going to be active in order to figure out plane
// indices.
return caps.maxCombinedDrawBuffersAndPixelLocalStoragePlanes - plsPlaneIdx - 1;
}
DrawBuffersVector<GLenum> mSavedDrawBuffers;
};
} // namespace
std::unique_ptr<PixelLocalStorage> PixelLocalStorage::Make(const Context *context)
{
const ShPixelLocalStorageOptions &plsOptions =
context->getImplementation()->getNativePixelLocalStorageOptions();
const Caps &caps = context->getState().getCaps();
switch (plsOptions.type)
{
case ShPixelLocalStorageType::ImageLoadStore:
return std::make_unique<PixelLocalStorageImageLoadStore>(plsOptions, caps);
case ShPixelLocalStorageType::FramebufferFetch:
return std::make_unique<PixelLocalStorageFramebufferFetch>(plsOptions, caps);
default:
UNREACHABLE();
return nullptr;
}
}
} // namespace gl