Hash :
c75bd915
Author :
Date :
2024-12-10T23:01:44
Vulkan: Remove asyncCommandQueue It's been years and it never showed an advantage. In the meantime, performance without this feature seems close to native drivers (i.e. the feature has lost its appeal) and it's frequently a source of complication and bugs. Bug: angleproject:42262955 Bug: angleproject:42265241 Bug: angleproject:42265934 Bug: angleproject:42265368 Bug: angleproject:42265738 Bug: angleproject:42266015 Bug: angleproject:377503738 Bug: angleproject:42265678 Bug: angleproject:173004081 Change-Id: Id8d7588fdbc397c28c1dd18aafa1f64cbe77806f Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/6084760 Reviewed-by: Amirali Abdolrashidi <abdolrashidi@google.com> Reviewed-by: mohan maiya <m.maiya@samsung.com> Reviewed-by: Charlie Lao <cclao@google.com> Commit-Queue: 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
//
// Copyright 2024 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.
//
// RefCountedEvent:
// Manages reference count of VkEvent and its associated functions.
//
#include "libANGLE/renderer/vulkan/vk_ref_counted_event.h"
#include "libANGLE/renderer/vulkan/vk_helpers.h"
#include "libANGLE/renderer/vulkan/vk_renderer.h"
namespace rx
{
namespace vk
{
namespace
{
// Predefined VkPipelineStageFlags for RefCountedEvent
constexpr angle::PackedEnumMap<EventStage, VkPipelineStageFlags>
kEventStageAndPipelineStageFlagsMap = {
{EventStage::Transfer, VK_PIPELINE_STAGE_TRANSFER_BIT},
{EventStage::VertexShader, VK_PIPELINE_STAGE_VERTEX_SHADER_BIT},
{EventStage::FragmentShader, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT},
{EventStage::ComputeShader, VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT},
{EventStage::AllShaders, kAllShadersPipelineStageFlags},
{EventStage::PreFragmentShaders, kPreFragmentStageFlags},
{EventStage::FragmentShadingRate,
VK_PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR},
{EventStage::ColorAttachmentOutput, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT},
{EventStage::ColorAttachmentOutputAndFragmentShader,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT},
{EventStage::ColorAttachmentOutputAndFragmentShaderAndTransfer,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | VK_PIPELINE_STAGE_TRANSFER_BIT |
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT},
{EventStage::ColorAttachmentOutputAndAllShaders,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | kAllShadersPipelineStageFlags},
{EventStage::AllFragmentTest, kAllDepthStencilPipelineStageFlags},
{EventStage::AllFragmentTestAndFragmentShader,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT | kAllDepthStencilPipelineStageFlags},
{EventStage::AllFragmentTestAndAllShaders,
kAllShadersPipelineStageFlags | kAllDepthStencilPipelineStageFlags},
{EventStage::TransferAndComputeShader,
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT | VK_PIPELINE_STAGE_TRANSFER_BIT}};
void DestroyRefCountedEvents(VkDevice device, RefCountedEventCollector &events)
{
while (!events.empty())
{
events.back().destroy(device);
events.pop_back();
}
}
} // namespace
void InitializeEventAndPipelineStagesMap(
angle::PackedEnumMap<EventStage, VkPipelineStageFlags> *map,
VkPipelineStageFlags supportedVulkanPipelineStageMask)
{
*map = kEventStageAndPipelineStageFlagsMap;
for (VkPipelineStageFlags &flag : *map)
{
flag &= supportedVulkanPipelineStageMask;
}
}
bool RefCountedEvent::init(Context *context, EventStage eventStage)
{
ASSERT(mHandle == nullptr);
ASSERT(eventStage != EventStage::InvalidEnum);
// First try with recycler. We must issue VkCmdResetEvent before VkCmdSetEvent
if (context->getRefCountedEventsGarbageRecycler()->fetch(context->getRenderer(), this))
{
ASSERT(valid());
ASSERT(!mHandle->isReferenced());
}
else
{
// If failed to fetch from recycler, then create a new event.
mHandle = new RefCounted<EventAndStage>;
VkEventCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_EVENT_CREATE_INFO;
// Use device only for performance reasons.
createInfo.flags = context->getFeatures().supportsSynchronization2.enabled
? VK_EVENT_CREATE_DEVICE_ONLY_BIT_KHR
: 0;
VkResult result = mHandle->get().event.init(context->getDevice(), createInfo);
if (result != VK_SUCCESS)
{
WARN() << "event.init failed. Clean up garbage and retry again";
// Proactively clean up garbage and retry
context->getRefCountedEventsGarbageRecycler()->cleanup(context->getRenderer());
result = mHandle->get().event.init(context->getDevice(), createInfo);
if (result != VK_SUCCESS)
{
// Drivers usually can allocate huge amount of VkEvents, and we should never use
// that many VkEvents under normal situation. If we failed to allocate, there is a
// high chance that we may have a leak somewhere. This macro should help us catch
// such potential bugs in the bots if that happens.
UNREACHABLE();
// If still fail to create, we just return. An invalid event will trigger
// pipelineBarrier code path
return false;
}
}
}
mHandle->addRef();
mHandle->get().eventStage = eventStage;
return true;
}
void RefCountedEvent::release(Context *context)
{
if (mHandle != nullptr)
{
releaseImpl(context->getRenderer(), context->getRefCountedEventsGarbageRecycler());
}
}
void RefCountedEvent::release(Renderer *renderer)
{
if (mHandle != nullptr)
{
releaseImpl(renderer, renderer->getRefCountedEventRecycler());
}
}
template <typename RecyclerT>
void RefCountedEvent::releaseImpl(Renderer *renderer, RecyclerT *recycler)
{
ASSERT(mHandle != nullptr);
// This should never be called from async clean up thread since the refcount is not atomic. It
// is expected only called under context share lock.
ASSERT(std::this_thread::get_id() != renderer->getCleanUpThreadId());
const bool isLastReference = mHandle->getAndReleaseRef() == 1;
if (isLastReference)
{
ASSERT(recycler != nullptr);
recycler->recycle(std::move(*this));
ASSERT(mHandle == nullptr);
}
else
{
mHandle = nullptr;
}
}
void RefCountedEvent::destroy(VkDevice device)
{
ASSERT(mHandle != nullptr);
ASSERT(!mHandle->isReferenced());
mHandle->get().event.destroy(device);
SafeDelete(mHandle);
}
// RefCountedEventsGarbage implementation.
void RefCountedEventsGarbage::destroy(Renderer *renderer)
{
ASSERT(renderer->hasQueueSerialFinished(mQueueSerial));
while (!mRefCountedEvents.empty())
{
ASSERT(mRefCountedEvents.back().valid());
mRefCountedEvents.back().release(renderer);
mRefCountedEvents.pop_back();
}
}
bool RefCountedEventsGarbage::releaseIfComplete(Renderer *renderer,
RefCountedEventsGarbageRecycler *recycler)
{
if (!renderer->hasQueueSerialFinished(mQueueSerial))
{
return false;
}
while (!mRefCountedEvents.empty())
{
ASSERT(mRefCountedEvents.back().valid());
mRefCountedEvents.back().releaseImpl(renderer, recycler);
ASSERT(!mRefCountedEvents.back().valid());
mRefCountedEvents.pop_back();
}
return true;
}
bool RefCountedEventsGarbage::moveIfComplete(Renderer *renderer,
std::deque<RefCountedEventCollector> *releasedBucket)
{
if (!renderer->hasQueueSerialFinished(mQueueSerial))
{
return false;
}
releasedBucket->emplace_back(std::move(mRefCountedEvents));
return true;
}
// RefCountedEventRecycler implementation.
void RefCountedEventRecycler::destroy(VkDevice device)
{
std::lock_guard<angle::SimpleMutex> lock(mMutex);
while (!mEventsToReset.empty())
{
DestroyRefCountedEvents(device, mEventsToReset.back());
mEventsToReset.pop_back();
}
ASSERT(mResettingQueue.empty());
while (!mEventsToReuse.empty())
{
DestroyRefCountedEvents(device, mEventsToReuse.back());
mEventsToReuse.pop_back();
}
}
void RefCountedEventRecycler::resetEvents(Context *context,
const QueueSerial queueSerial,
PrimaryCommandBuffer *commandbuffer)
{
std::lock_guard<angle::SimpleMutex> lock(mMutex);
if (mEventsToReset.empty())
{
return;
}
Renderer *renderer = context->getRenderer();
while (!mEventsToReset.empty())
{
RefCountedEventCollector &events = mEventsToReset.back();
ASSERT(!events.empty());
for (const RefCountedEvent &refCountedEvent : events)
{
VkPipelineStageFlags stageMask = renderer->getEventPipelineStageMask(refCountedEvent);
commandbuffer->resetEvent(refCountedEvent.getEvent().getHandle(), stageMask);
}
mResettingQueue.emplace(queueSerial, std::move(events));
mEventsToReset.pop_back();
}
}
size_t RefCountedEventRecycler::cleanupResettingEvents(Renderer *renderer)
{
size_t eventsReleased = 0;
std::lock_guard<angle::SimpleMutex> lock(mMutex);
while (!mResettingQueue.empty())
{
bool released = mResettingQueue.front().moveIfComplete(renderer, &mEventsToReuse);
if (released)
{
mResettingQueue.pop();
++eventsReleased;
}
else
{
break;
}
}
return eventsReleased;
}
bool RefCountedEventRecycler::fetchEventsToReuse(RefCountedEventCollector *eventsToReuseOut)
{
ASSERT(eventsToReuseOut != nullptr);
ASSERT(eventsToReuseOut->empty());
std::lock_guard<angle::SimpleMutex> lock(mMutex);
if (mEventsToReuse.empty())
{
return false;
}
eventsToReuseOut->swap(mEventsToReuse.back());
mEventsToReuse.pop_back();
return true;
}
// RefCountedEventsGarbageRecycler implementation.
RefCountedEventsGarbageRecycler::~RefCountedEventsGarbageRecycler()
{
ASSERT(mEventsToReset.empty());
ASSERT(mGarbageQueue.empty());
ASSERT(mEventsToReuse.empty());
ASSERT(mGarbageCount == 0);
}
void RefCountedEventsGarbageRecycler::destroy(Renderer *renderer)
{
VkDevice device = renderer->getDevice();
DestroyRefCountedEvents(device, mEventsToReset);
ASSERT(mGarbageQueue.empty());
ASSERT(mGarbageCount == 0);
mEventsToReuse.destroy(device);
}
void RefCountedEventsGarbageRecycler::cleanup(Renderer *renderer)
{
// First cleanup already completed events and add to mEventsToReset
while (!mGarbageQueue.empty())
{
size_t count = mGarbageQueue.front().size();
bool released = mGarbageQueue.front().releaseIfComplete(renderer, this);
if (released)
{
mGarbageCount -= count;
mGarbageQueue.pop();
}
else
{
break;
}
}
// Move mEventsToReset to the renderer so that it can be reset.
if (!mEventsToReset.empty())
{
renderer->getRefCountedEventRecycler()->recycle(std::move(mEventsToReset));
}
}
bool RefCountedEventsGarbageRecycler::fetch(Renderer *renderer, RefCountedEvent *outObject)
{
if (mEventsToReuse.empty())
{
// Retrieve a list of ready to reuse events from renderer.
RefCountedEventCollector events;
if (!renderer->getRefCountedEventRecycler()->fetchEventsToReuse(&events))
{
return false;
}
mEventsToReuse.refill(std::move(events));
ASSERT(!mEventsToReuse.empty());
}
mEventsToReuse.fetch(outObject);
return true;
}
// EventBarrier implementation.
void EventBarrier::addDiagnosticsString(std::ostringstream &out) const
{
if (mMemoryBarrierSrcAccess != 0 || mMemoryBarrierDstAccess != 0)
{
out << "Src: 0x" << std::hex << mMemoryBarrierSrcAccess << " → Dst: 0x" << std::hex
<< mMemoryBarrierDstAccess << std::endl;
}
}
void EventBarrier::execute(PrimaryCommandBuffer *primary)
{
if (isEmpty())
{
return;
}
ASSERT(mEvent != VK_NULL_HANDLE);
ASSERT(mImageMemoryBarrierCount == 0 ||
(mImageMemoryBarrierCount == 1 && mImageMemoryBarrier.image != VK_NULL_HANDLE));
// Issue vkCmdWaitEvents call
VkMemoryBarrier memoryBarrier = {};
memoryBarrier.sType = VK_STRUCTURE_TYPE_MEMORY_BARRIER;
memoryBarrier.srcAccessMask = mMemoryBarrierSrcAccess;
memoryBarrier.dstAccessMask = mMemoryBarrierDstAccess;
primary->waitEvents(1, &mEvent, mSrcStageMask, mDstStageMask, 1, &memoryBarrier, 0, nullptr,
mImageMemoryBarrierCount,
mImageMemoryBarrierCount == 0 ? nullptr : &mImageMemoryBarrier);
}
// EventBarrierArray implementation.
void EventBarrierArray::addAdditionalStageAccess(const RefCountedEvent &waitEvent,
VkPipelineStageFlags dstStageMask,
VkAccessFlags dstAccess)
{
for (EventBarrier &barrier : mBarriers)
{
if (barrier.hasEvent(waitEvent.getEvent().getHandle()))
{
barrier.addAdditionalStageAccess(dstStageMask, dstAccess);
return;
}
}
UNREACHABLE();
}
void EventBarrierArray::addMemoryEvent(Renderer *renderer,
const RefCountedEvent &waitEvent,
VkPipelineStageFlags dstStageMask,
VkAccessFlags dstAccess)
{
ASSERT(waitEvent.valid());
VkPipelineStageFlags stageFlags = renderer->getEventPipelineStageMask(waitEvent);
// This should come down as WAW without layout change, dstStageMask should be the same as
// event's stageMask. Otherwise you should get into addImageEvent.
ASSERT(stageFlags == dstStageMask);
mBarriers.emplace_back(stageFlags, dstStageMask, dstAccess, dstAccess,
waitEvent.getEvent().getHandle());
}
void EventBarrierArray::addImageEvent(Renderer *renderer,
const RefCountedEvent &waitEvent,
VkPipelineStageFlags dstStageMask,
const VkImageMemoryBarrier &imageMemoryBarrier)
{
ASSERT(waitEvent.valid());
VkPipelineStageFlags srcStageFlags = renderer->getEventPipelineStageMask(waitEvent);
mBarriers.emplace_back(srcStageFlags, dstStageMask, waitEvent.getEvent().getHandle(),
imageMemoryBarrier);
}
void EventBarrierArray::execute(Renderer *renderer, PrimaryCommandBuffer *primary)
{
while (!mBarriers.empty())
{
mBarriers.back().execute(primary);
mBarriers.pop_back();
}
reset();
}
void EventBarrierArray::addDiagnosticsString(std::ostringstream &out) const
{
out << "Event Barrier: ";
for (const EventBarrier &barrier : mBarriers)
{
barrier.addDiagnosticsString(out);
}
out << "\\l";
}
} // namespace vk
} // namespace rx